org.eclipse.vtp.framework.interactions.voice.vxml
Class Return

java.lang.Object
  org.eclipse.vtp.framework.interactions.core.support.Widget
      org.eclipse.vtp.framework.interactions.voice.vxml.Action
          org.eclipse.vtp.framework.interactions.voice.vxml.Return

All Implemented Interfaces:

VXMLConstants

public class Return
extends Action

The Return class represents the <return> VXML element. The return element ends execution of a subdialog and returns control and data to a calling dialog. The data can either be in the form of an event that is thrown upon returning or a list of variables in the scope of the subdialog to add to the scope of the calling dialog.

Version:

2.0

Author:

Trip Gilman, Lonnie Pryor

Field Summary

Fields inherited from interface org.eclipse.vtp.framework.interactions.voice.vxml.VXMLConstants

EMPTY, FILE_EXT_GSL, FILLED_MODE_ALL, FILLED_MODE_ANY, GRAMMAR_MODE_DTMF, GRAMMAR_MODE_VOICE, METHOD_GET, METHOD_POST, MIME_TYPE_GSL, MIME_TYPE_SRGS, NAME_APPLICATION, NAME_ASSIGN, NAME_AUDIO, NAME_BARGEIN, NAME_BEEP, NAME_BLOCK, NAME_BRIDGE, NAME_CATCH, NAME_CHOICE, NAME_COMPLETETIMEOUT, NAME_COND, NAME_CONFIDENCELEVEL, NAME_COUNT, NAME_DEST, NAME_DISCONNECT, NAME_DTMF, NAME_DTMFTERM, NAME_ELSE, NAME_ELSEIF, NAME_ENCTYPE, NAME_ENUMERATE, NAME_ERROR, NAME_EVENT, NAME_EVENTEXPR, NAME_EXIT, NAME_EXPR, NAME_FIELD, NAME_FILLED, NAME_FINALSILENCE, NAME_FORM, NAME_GOTO, NAME_GRAMMAR, NAME_ID, NAME_IF, NAME_INCOMPLETETIMEOUT, NAME_INPUTMODES, NAME_INTERDIGITTIMEOUT, NAME_ITEM, NAME_MAXNBEST, NAME_MAXSPEECHTIMEOUT, NAME_MAXTIME, NAME_MENU, NAME_METHOD, NAME_MODE, NAME_NAME, NAME_NAMELIST, NAME_NEXT, NAME_NOINPUT, NAME_NOMATCH, NAME_ONE_OF, NAME_OPTION, NAME_PARAM, NAME_PROMPT, NAME_PROPERTY, NAME_RECORD, NAME_REPEAT, NAME_REPROMPT, NAME_RETURN, NAME_ROOT, NAME_RULE, NAME_SCOPE, NAME_SCRIPT, NAME_SENSITIVITY, NAME_SPEEDVSACCURACY, NAME_SRC, NAME_SUBDIALOG, NAME_SUBMIT, NAME_TERMCHAR, NAME_TERMTIMEOUT, NAME_THROW, NAME_TIMEOUT, NAME_TRANSFER, NAME_TYPE, NAME_VALUE, NAME_VAR, NAME_VERSION, NAME_VXML, NAMESPACE_URI_VXML, QNAME_XML_LANG, SCOPE_DIALOG, SCOPE_DOCUMENT, TYPE_CDATA, VERSION_2_0

Constructor Summary

Return(java.lang.String eventName)
Creates a new Return object that throws the specified event upon returning to the caller dialog.

Return(java.lang.String[] names)
Creates a new Return object that copies the named variables from the subdialog's scope into the scope of the calling dialog.

Method Summary

void	addName(java.lang.String name) Adds the variable name to the list of variable names that will be copied into the calling dialog's scope.
java.lang.String	getEventName() Returns the name of the event this return object will throw.
java.lang.String[]	getNames() Returns the list of variable names that will be copied into the calling dialog's scope.
void	removeName(java.lang.String name) Removes the variable name from the list of variable names that will be copied into the calling dialog's scope.
void	setEventName(java.lang.String eventName) Sets the name of the event this return object will throw.
protected void	writeAttributes(org.xml.sax.helpers.AttributesImpl attributes) Write the attribute members of this action to the supplied set.
void	writeWidget(org.xml.sax.ContentHandler outputHandler) Writes the content of this widget to an XML content handler.

Methods inherited from class org.eclipse.vtp.framework.interactions.core.support.Widget

toString, writeAttribute, writeChildren, writeChildren, writeWidget, writeWidget

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Return

public Return(java.lang.String eventName)

Creates a new Return object that throws the specified event upon returning to the caller dialog.

Parameters:

eventName - Name of the event to throw.

Throws:

java.lang.IllegalArgumentException - If the supplied event name is empty.

Return

public Return(java.lang.String[] names)
       throws java.lang.IllegalArgumentException,
              java.lang.NullPointerException

Creates a new Return object that copies the named variables from the subdialog's scope into the scope of the calling dialog.

Parameters:

names - List of variables to copy.

Throws:

java.lang.IllegalArgumentException - If any of the supplied names are empty.

java.lang.NullPointerException - If any of the supplied names are null.

Method Detail

getEventName

public java.lang.String getEventName()

Returns the name of the event this return object will throw.

Returns:

the name of the event.

getNames

public java.lang.String[] getNames()

Returns the list of variable names that will be copied into the calling dialog's scope.

Returns:

the list of variable names.

setEventName

public void setEventName(java.lang.String eventName)
                  throws java.lang.IllegalArgumentException

Sets the name of the event this return object will throw.

Parameters:

eventName - The name of the event this return object will throw.

Throws:

java.lang.IllegalArgumentException - If the supplied event name is empty.

addName

public void addName(java.lang.String name)
             throws java.lang.IllegalArgumentException,
                    java.lang.NullPointerException

Adds the variable name to the list of variable names that will be copied into the calling dialog's scope.

Parameters:

name - The variable name to add.

Throws:

java.lang.IllegalArgumentException - If the supplied name is empty.

java.lang.NullPointerException - If the supplied name is null.

removeName

public void removeName(java.lang.String name)
                throws java.lang.IllegalArgumentException,
                       java.lang.NullPointerException

Removes the variable name from the list of variable names that will be copied into the calling dialog's scope.

Parameters:

name - The variable name to remove.

Throws:

java.lang.IllegalArgumentException - If the supplied name is empty.

java.lang.NullPointerException - If the supplied name is null.

writeWidget

public void writeWidget(org.xml.sax.ContentHandler outputHandler)
                 throws java.lang.NullPointerException,
                        org.xml.sax.SAXException

Description copied from class: Widget

Writes the content of this widget to an XML content handler.

Specified by:

writeWidget in class Widget

Parameters:

outputHandler - The handler to write this widget to.

Throws:

java.lang.NullPointerException - If the supplied content handler is null.

org.xml.sax.SAXException - If the writing of this widget fails.

writeAttributes

protected void writeAttributes(org.xml.sax.helpers.AttributesImpl attributes)

Write the attribute members of this action to the supplied set.

Parameters:

attributes - The attribute set to write to.

Throws:

java.lang.NullPointerException - If the supplied attribute set is null.